<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2011 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: StreamRepository.html 883 2014-05-07 02:45:34Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.dellroad.stuff.io;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.io.IOException;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.io.InputStream;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.io.OutputStream;<a name="line.12"></a>
<span class="sourceLineNo">013</span><a name="line.13"></a>
<span class="sourceLineNo">014</span>/**<a name="line.14"></a>
<span class="sourceLineNo">015</span> * Interface for atomic storage and retrieval of an opaque byte array, with access being done<a name="line.15"></a>
<span class="sourceLineNo">016</span> * via {@link InputStream} and {@link OutputStream} interfaces.<a name="line.16"></a>
<span class="sourceLineNo">017</span> *<a name="line.17"></a>
<span class="sourceLineNo">018</span> * &lt;p&gt;<a name="line.18"></a>
<span class="sourceLineNo">019</span> * Conceptually, there is a single underlying byte array. Instances behave as if an atomic readable snapshot<a name="line.19"></a>
<span class="sourceLineNo">020</span> * is made when {@link #getInputStream} is invoked, and the results of that snapshot are then available<a name="line.20"></a>
<span class="sourceLineNo">021</span> * in the returned {@link InputStream}. Similarly, instances behave as if the underlying byte array is<a name="line.21"></a>
<span class="sourceLineNo">022</span> * atomically updated when the output stream returned by {@link #getOutputStream} is successfully<a name="line.22"></a>
<span class="sourceLineNo">023</span> * {@linkplain OutputStream#close closed}.<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * Instances are thread safe, and support multiple concurrent open input and output streams. In particular,<a name="line.26"></a>
<span class="sourceLineNo">027</span> * two output streams may be {@linkplain OutputStream#close closed} at the same time by two different threads,<a name="line.27"></a>
<span class="sourceLineNo">028</span> * and one will always win the race.<a name="line.28"></a>
<span class="sourceLineNo">029</span> */<a name="line.29"></a>
<span class="sourceLineNo">030</span>public interface StreamRepository {<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /**<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * Get an input stream reading the current value of the underlying store.<a name="line.33"></a>
<span class="sourceLineNo">034</span>     *<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * @throws IOException if an error occurs<a name="line.35"></a>
<span class="sourceLineNo">036</span>     */<a name="line.36"></a>
<span class="sourceLineNo">037</span>    InputStream getInputStream() throws IOException;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>    /**<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * Get an output stream writing to the underlying store. The underlying store is not affected until the<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * returned output stream is successfully {@linkplain OutputStream#close closed}, at which time it is<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * atomically updated with the newly written content.<a name="line.42"></a>
<span class="sourceLineNo">043</span>     *<a name="line.43"></a>
<span class="sourceLineNo">044</span>     * &lt;p&gt;<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * If the returned stream throws an {@link IOException} at any time, including during {@link OutputStream#close close()},<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * or if {@link OutputStream#close close()} is never invoked, then no update to the underlying storage occurs.<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * &lt;/p&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span>     *<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * @throws IOException if an error occurs<a name="line.49"></a>
<span class="sourceLineNo">050</span>     */<a name="line.50"></a>
<span class="sourceLineNo">051</span>    OutputStream getOutputStream() throws IOException;<a name="line.51"></a>
<span class="sourceLineNo">052</span>}<a name="line.52"></a>
<span class="sourceLineNo">053</span><a name="line.53"></a>




























































</pre>
</div>
</body>
</html>
